<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<!-- Copyright (C) 1988-2023 Free Software Foundation, Inc.

Permission is granted to copy, distribute and/or modify this document
under the terms of the GNU Free Documentation License, Version 1.3 or
any later version published by the Free Software Foundation; with the
Invariant Sections being "Funding Free Software", the Front-Cover
Texts being (a) (see below), and with the Back-Cover Texts being (b)
(see below).  A copy of the license is included in the section entitled
"GNU Free Documentation License".

(a) The FSF's Front-Cover Text is:

A GNU Manual

(b) The FSF's Back-Cover Text is:

You have freedom to copy and modify this GNU Manual, like GNU
     software.  Copies published by the Free Software Foundation raise
     funds for GNU development. -->
<!-- Created by GNU Texinfo 6.7, http://www.gnu.org/software/texinfo/ -->
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<title>Simple Constraints (GNU Compiler Collection (GCC) Internals)</title>

<meta name="description" content="Simple Constraints (GNU Compiler Collection (GCC) Internals)">
<meta name="keywords" content="Simple Constraints (GNU Compiler Collection (GCC) Internals)">
<meta name="resource-type" content="document">
<meta name="distribution" content="global">
<meta name="Generator" content="makeinfo">
<link href="index.html" rel="start" title="Top">
<link href="Option-Index.html" rel="index" title="Option Index">
<link href="index.html#SEC_Contents" rel="contents" title="Table of Contents">
<link href="Constraints.html" rel="up" title="Constraints">
<link href="Multi_002dAlternative.html" rel="next" title="Multi-Alternative">
<link href="Constraints.html" rel="prev" title="Constraints">
<style type="text/css">
<!--
a.summary-letter {text-decoration: none}
blockquote.indentedblock {margin-right: 0em}
div.display {margin-left: 3.2em}
div.example {margin-left: 3.2em}
div.lisp {margin-left: 3.2em}
kbd {font-style: oblique}
pre.display {font-family: inherit}
pre.format {font-family: inherit}
pre.menu-comment {font-family: serif}
pre.menu-preformatted {font-family: serif}
span.nolinebreak {white-space: nowrap}
span.roman {font-family: initial; font-weight: normal}
span.sansserif {font-family: sans-serif; font-weight: normal}
ul.no-bullet {list-style: none}
-->
</style>


</head>

<body lang="en">
<span id="Simple-Constraints"></span><div class="header">
<p>
Next: <a href="Multi_002dAlternative.html" accesskey="n" rel="next">Multi-Alternative</a>, Up: <a href="Constraints.html" accesskey="u" rel="up">Constraints</a> &nbsp; [<a href="index.html#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="Option-Index.html" title="Index" rel="index">Index</a>]</p>
</div>
<hr>
<span id="Simple-Constraints-1"></span><h4 class="subsection">17.8.1 Simple Constraints</h4>
<span id="index-simple-constraints"></span>

<p>The simplest kind of constraint is a string full of letters, each of
which describes one kind of operand that is permitted.  Here are
the letters that are allowed:
</p>
<dl compact="compact">
<dt>whitespace</dt>
<dd><p>Whitespace characters are ignored and can be inserted at any position
except the first.  This enables each alternative for different operands to
be visually aligned in the machine description even if they have different
number of constraints and modifiers.
</p>
<span id="index-m-in-constraint"></span>
<span id="index-memory-references-in-constraints"></span>
</dd>
<dt>&lsquo;<samp>m</samp>&rsquo;</dt>
<dd><p>A memory operand is allowed, with any kind of address that the machine
supports in general.
Note that the letter used for the general memory constraint can be
re-defined by a back end using the <code>TARGET_MEM_CONSTRAINT</code> macro.
</p>
<span id="index-offsettable-address"></span>
<span id="index-o-in-constraint"></span>
</dd>
<dt>&lsquo;<samp>o</samp>&rsquo;</dt>
<dd><p>A memory operand is allowed, but only if the address is
<em>offsettable</em>.  This means that adding a small integer (actually,
the width in bytes of the operand, as determined by its machine mode)
may be added to the address and the result is also a valid memory
address.
</p>
<span id="index-autoincrement_002fdecrement-addressing"></span>
<p>For example, an address which is constant is offsettable; so is an
address that is the sum of a register and a constant (as long as a
slightly larger constant is also within the range of address-offsets
supported by the machine); but an autoincrement or autodecrement
address is not offsettable.  More complicated indirect/indexed
addresses may or may not be offsettable depending on the other
addressing modes that the machine supports.
</p>
<p>Note that in an output operand which can be matched by another
operand, the constraint letter &lsquo;<samp>o</samp>&rsquo; is valid only when accompanied
by both &lsquo;<samp>&lt;</samp>&rsquo; (if the target machine has predecrement addressing)
and &lsquo;<samp>&gt;</samp>&rsquo; (if the target machine has preincrement addressing).
</p>
<span id="index-V-in-constraint"></span>
</dd>
<dt>&lsquo;<samp>V</samp>&rsquo;</dt>
<dd><p>A memory operand that is not offsettable.  In other words, anything that
would fit the &lsquo;<samp>m</samp>&rsquo; constraint but not the &lsquo;<samp>o</samp>&rsquo; constraint.
</p>
<span id="index-_003c-in-constraint"></span>
</dd>
<dt>&lsquo;<samp>&lt;</samp>&rsquo;</dt>
<dd><p>A memory operand with autodecrement addressing (either predecrement or
postdecrement) is allowed.  In inline <code>asm</code> this constraint is only
allowed if the operand is used exactly once in an instruction that can
handle the side effects.  Not using an operand with &lsquo;<samp>&lt;</samp>&rsquo; in constraint
string in the inline <code>asm</code> pattern at all or using it in multiple
instructions isn&rsquo;t valid, because the side effects wouldn&rsquo;t be performed
or would be performed more than once.  Furthermore, on some targets
the operand with &lsquo;<samp>&lt;</samp>&rsquo; in constraint string must be accompanied by
special instruction suffixes like <code>%U0</code> instruction suffix on PowerPC
or <code>%P0</code> on IA-64.
</p>
<span id="index-_003e-in-constraint"></span>
</dd>
<dt>&lsquo;<samp>&gt;</samp>&rsquo;</dt>
<dd><p>A memory operand with autoincrement addressing (either preincrement or
postincrement) is allowed.  In inline <code>asm</code> the same restrictions
as for &lsquo;<samp>&lt;</samp>&rsquo; apply.
</p>
<span id="index-r-in-constraint"></span>
<span id="index-registers-in-constraints"></span>
</dd>
<dt>&lsquo;<samp>r</samp>&rsquo;</dt>
<dd><p>A register operand is allowed provided that it is in a general
register.
</p>
<span id="index-constants-in-constraints"></span>
<span id="index-i-in-constraint"></span>
</dd>
<dt>&lsquo;<samp>i</samp>&rsquo;</dt>
<dd><p>An immediate integer operand (one with constant value) is allowed.
This includes symbolic constants whose values will be known only at
assembly time or later.
</p>
<span id="index-n-in-constraint"></span>
</dd>
<dt>&lsquo;<samp>n</samp>&rsquo;</dt>
<dd><p>An immediate integer operand with a known numeric value is allowed.
Many systems cannot support assembly-time constants for operands less
than a word wide.  Constraints for these operands should use &lsquo;<samp>n</samp>&rsquo;
rather than &lsquo;<samp>i</samp>&rsquo;.
</p>
<span id="index-I-in-constraint"></span>
</dd>
<dt>&lsquo;<samp>I</samp>&rsquo;, &lsquo;<samp>J</samp>&rsquo;, &lsquo;<samp>K</samp>&rsquo;, &hellip; &lsquo;<samp>P</samp>&rsquo;</dt>
<dd><p>Other letters in the range &lsquo;<samp>I</samp>&rsquo; through &lsquo;<samp>P</samp>&rsquo; may be defined in
a machine-dependent fashion to permit immediate integer operands with
explicit integer values in specified ranges.  For example, on the
68000, &lsquo;<samp>I</samp>&rsquo; is defined to stand for the range of values 1 to 8.
This is the range permitted as a shift count in the shift
instructions.
</p>
<span id="index-E-in-constraint"></span>
</dd>
<dt>&lsquo;<samp>E</samp>&rsquo;</dt>
<dd><p>An immediate floating operand (expression code <code>const_double</code>) is
allowed, but only if the target floating point format is the same as
that of the host machine (on which the compiler is running).
</p>
<span id="index-F-in-constraint"></span>
</dd>
<dt>&lsquo;<samp>F</samp>&rsquo;</dt>
<dd><p>An immediate floating operand (expression code <code>const_double</code> or
<code>const_vector</code>) is allowed.
</p>
<span id="index-G-in-constraint"></span>
<span id="index-H-in-constraint"></span>
</dd>
<dt>&lsquo;<samp>G</samp>&rsquo;, &lsquo;<samp>H</samp>&rsquo;</dt>
<dd><p>&lsquo;<samp>G</samp>&rsquo; and &lsquo;<samp>H</samp>&rsquo; may be defined in a machine-dependent fashion to
permit immediate floating operands in particular ranges of values.
</p>
<span id="index-s-in-constraint"></span>
</dd>
<dt>&lsquo;<samp>s</samp>&rsquo;</dt>
<dd><p>An immediate integer operand whose value is not an explicit integer is
allowed.
</p>
<p>This might appear strange; if an insn allows a constant operand with a
value not known at compile time, it certainly must allow any known
value.  So why use &lsquo;<samp>s</samp>&rsquo; instead of &lsquo;<samp>i</samp>&rsquo;?  Sometimes it allows
better code to be generated.
</p>
<p>For example, on the 68000 in a fullword instruction it is possible to
use an immediate operand; but if the immediate value is between -128
and 127, better code results from loading the value into a register and
using the register.  This is because the load into the register can be
done with a &lsquo;<samp>moveq</samp>&rsquo; instruction.  We arrange for this to happen
by defining the letter &lsquo;<samp>K</samp>&rsquo; to mean &ldquo;any integer outside the
range -128 to 127&rdquo;, and then specifying &lsquo;<samp>Ks</samp>&rsquo; in the operand
constraints.
</p>
<span id="index-g-in-constraint"></span>
</dd>
<dt>&lsquo;<samp>g</samp>&rsquo;</dt>
<dd><p>Any register, memory or immediate integer operand is allowed, except for
registers that are not general registers.
</p>
<span id="index-X-in-constraint"></span>
</dd>
<dt>&lsquo;<samp>X</samp>&rsquo;</dt>
<dd><p>Any operand whatsoever is allowed, even if it does not satisfy
<code>general_operand</code>.  This is normally used in the constraint of
a <code>match_scratch</code> when certain alternatives will not actually
require a scratch register.
</p>
<span id="index-0-in-constraint"></span>
<span id="index-digits-in-constraint"></span>
</dd>
<dt>&lsquo;<samp>0</samp>&rsquo;, &lsquo;<samp>1</samp>&rsquo;, &lsquo;<samp>2</samp>&rsquo;, &hellip; &lsquo;<samp>9</samp>&rsquo;</dt>
<dd><p>An operand that matches the specified operand number is allowed.  If a
digit is used together with letters within the same alternative, the
digit should come last.
</p>
<p>This number is allowed to be more than a single digit.  If multiple
digits are encountered consecutively, they are interpreted as a single
decimal integer.  There is scant chance for ambiguity, since to-date
it has never been desirable that &lsquo;<samp>10</samp>&rsquo; be interpreted as matching
either operand 1 <em>or</em> operand 0.  Should this be desired, one
can use multiple alternatives instead.
</p>
<span id="index-matching-constraint"></span>
<span id="index-constraint_002c-matching"></span>
<p>This is called a <em>matching constraint</em> and what it really means is
that the assembler has only a single operand that fills two roles
considered separate in the RTL insn.  For example, an add insn has two
input operands and one output operand in the RTL, but on most CISC
machines an add instruction really has only two operands, one of them an
input-output operand:
</p>
<div class="example">
<pre class="example">addl #35,r12
</pre></div>

<p>Matching constraints are used in these circumstances.
More precisely, the two operands that match must include one input-only
operand and one output-only operand.  Moreover, the digit must be a
smaller number than the number of the operand that uses it in the
constraint.
</p>
<p>For operands to match in a particular case usually means that they
are identical-looking RTL expressions.  But in a few special cases
specific kinds of dissimilarity are allowed.  For example, <code>*x</code>
as an input operand will match <code>*x++</code> as an output operand.
For proper results in such cases, the output template should always
use the output-operand&rsquo;s number when printing the operand.
</p>
<span id="index-load-address-instruction"></span>
<span id="index-push-address-instruction"></span>
<span id="index-address-constraints"></span>
<span id="index-p-in-constraint"></span>
</dd>
<dt>&lsquo;<samp>p</samp>&rsquo;</dt>
<dd><p>An operand that is a valid memory address is allowed.  This is
for &ldquo;load address&rdquo; and &ldquo;push address&rdquo; instructions.
</p>
<span id="index-address_005foperand-1"></span>
<p>&lsquo;<samp>p</samp>&rsquo; in the constraint must be accompanied by <code>address_operand</code>
as the predicate in the <code>match_operand</code>.  This predicate interprets
the mode specified in the <code>match_operand</code> as the mode of the memory
reference for which the address would be valid.
</p>
<span id="index-other-register-constraints"></span>
<span id="index-extensible-constraints"></span>
</dd>
<dt><var>other-letters</var></dt>
<dd><p>Other letters can be defined in machine-dependent fashion to stand for
particular classes of registers or other arbitrary operand types.
&lsquo;<samp>d</samp>&rsquo;, &lsquo;<samp>a</samp>&rsquo; and &lsquo;<samp>f</samp>&rsquo; are defined on the 68000/68020 to stand
for data, address and floating point registers.
</p></dd>
</dl>

<p>In order to have valid assembler code, each operand must satisfy
its constraint.  But a failure to do so does not prevent the pattern
from applying to an insn.  Instead, it directs the compiler to modify
the code so that the constraint will be satisfied.  Usually this is
done by copying an operand into a register.
</p>
<p>Contrast, therefore, the two instruction patterns that follow:
</p>
<div class="example">
<pre class="example">(define_insn &quot;&quot;
  [(set (match_operand:SI 0 &quot;general_operand&quot; &quot;=r&quot;)
        (plus:SI (match_dup 0)
                 (match_operand:SI 1 &quot;general_operand&quot; &quot;r&quot;)))]
  &quot;&quot;
  &quot;&hellip;&quot;)
</pre></div>

<p>which has two operands, one of which must appear in two places, and
</p>
<div class="example">
<pre class="example">(define_insn &quot;&quot;
  [(set (match_operand:SI 0 &quot;general_operand&quot; &quot;=r&quot;)
        (plus:SI (match_operand:SI 1 &quot;general_operand&quot; &quot;0&quot;)
                 (match_operand:SI 2 &quot;general_operand&quot; &quot;r&quot;)))]
  &quot;&quot;
  &quot;&hellip;&quot;)
</pre></div>

<p>which has three operands, two of which are required by a constraint to be
identical.  If we are considering an insn of the form
</p>
<div class="example">
<pre class="example">(insn <var>n</var> <var>prev</var> <var>next</var>
  (set (reg:SI 3)
       (plus:SI (reg:SI 6) (reg:SI 109)))
  &hellip;)
</pre></div>

<p>the first pattern would not apply at all, because this insn does not
contain two identical subexpressions in the right place.  The pattern would
say, &ldquo;That does not look like an add instruction; try other patterns&rdquo;.
The second pattern would say, &ldquo;Yes, that&rsquo;s an add instruction, but there
is something wrong with it&rdquo;.  It would direct the reload pass of the
compiler to generate additional insns to make the constraint true.  The
results might look like this:
</p>
<div class="example">
<pre class="example">(insn <var>n2</var> <var>prev</var> <var>n</var>
  (set (reg:SI 3) (reg:SI 6))
  &hellip;)

(insn <var>n</var> <var>n2</var> <var>next</var>
  (set (reg:SI 3)
       (plus:SI (reg:SI 3) (reg:SI 109)))
  &hellip;)
</pre></div>

<p>It is up to you to make sure that each operand, in each pattern, has
constraints that can handle any RTL expression that could be present for
that operand.  (When multiple alternatives are in use, each pattern must,
for each possible combination of operand expressions, have at least one
alternative which can handle that combination of operands.)  The
constraints don&rsquo;t need to <em>allow</em> any possible operand&mdash;when this is
the case, they do not constrain&mdash;but they must at least point the way to
reloading any possible operand so that it will fit.
</p>
<ul>
<li> If the constraint accepts whatever operands the predicate permits,
there is no problem: reloading is never necessary for this operand.

<p>For example, an operand whose constraints permit everything except
registers is safe provided its predicate rejects registers.
</p>
<p>An operand whose predicate accepts only constant values is safe
provided its constraints include the letter &lsquo;<samp>i</samp>&rsquo;.  If any possible
constant value is accepted, then nothing less than &lsquo;<samp>i</samp>&rsquo; will do;
if the predicate is more selective, then the constraints may also be
more selective.
</p>
</li><li> Any operand expression can be reloaded by copying it into a register.
So if an operand&rsquo;s constraints allow some kind of register, it is
certain to be safe.  It need not permit all classes of registers; the
compiler knows how to copy a register into another register of the
proper class in order to make an instruction valid.

</li><li> <span id="index-nonoffsettable-memory-reference"></span>
<span id="index-memory-reference_002c-nonoffsettable"></span>
A nonoffsettable memory reference can be reloaded by copying the
address into a register.  So if the constraint uses the letter
&lsquo;<samp>o</samp>&rsquo;, all memory references are taken care of.

</li><li> A constant operand can be reloaded by allocating space in memory to
hold it as preinitialized data.  Then the memory reference can be used
in place of the constant.  So if the constraint uses the letters
&lsquo;<samp>o</samp>&rsquo; or &lsquo;<samp>m</samp>&rsquo;, constant operands are not a problem.

</li><li> If the constraint permits a constant and a pseudo register used in an insn
was not allocated to a hard register and is equivalent to a constant,
the register will be replaced with the constant.  If the predicate does
not permit a constant and the insn is re-recognized for some reason, the
compiler will crash.  Thus the predicate must always recognize any
objects allowed by the constraint.
</li></ul>

<p>If the operand&rsquo;s predicate can recognize registers, but the constraint does
not permit them, it can make the compiler crash.  When this operand happens
to be a register, the reload pass will be stymied, because it does not know
how to copy a register temporarily into memory.
</p>
<p>If the predicate accepts a unary operator, the constraint applies to the
operand.  For example, the MIPS processor at ISA level 3 supports an
instruction which adds two registers in <code>SImode</code> to produce a
<code>DImode</code> result, but only if the registers are correctly sign
extended.  This predicate for the input operands accepts a
<code>sign_extend</code> of an <code>SImode</code> register.  Write the constraint
to indicate the type of register that is required for the operand of the
<code>sign_extend</code>.
</p>
<hr>
<div class="header">
<p>
Next: <a href="Multi_002dAlternative.html" accesskey="n" rel="next">Multi-Alternative</a>, Up: <a href="Constraints.html" accesskey="u" rel="up">Constraints</a> &nbsp; [<a href="index.html#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="Option-Index.html" title="Index" rel="index">Index</a>]</p>
</div>



</body>
</html>
